<!DOCTYPE html>
<html>
<head>
	<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
	<meta name="generator" content="ApiGen 2.7.0" />

	<title>Class AMFObject | nort</title>

	<script type="text/javascript" src="resources/combined.js?1481722677"></script>
	<script type="text/javascript" src="elementlist.js?1094816827"></script>
	<link rel="stylesheet" type="text/css" media="all" href="resources/style.css?1567499433" />

</head>

<body>
<div id="left">
	<div id="menu">
		<a href="index.html" title="Overview"><span>Overview</span></a>


		<div id="groups">
			<h3>Packages</h3>
			<ul>
				<li><a href="package-App.html">App<span></span></a>
						<ul>
				<li><a href="package-App.Saas.html">Saas</a>
						</li>
				<li><a href="package-App.saas.html">saas</a>
						</li>
				<li><a href="package-App.SaaS.html">SaaS<span></span></a>
						<ul>
				<li><a href="package-App.saas.Logic.html">Logic</a>
						</li>
				<li><a href="package-App.SaaS.SaaS.html">SaaS</a>
						</li>
				<li><a href="package-App.Saas.Tables.html">Tables</a>
						</li>
				<li><a href="package-App.Saas.Vo.html">Vo</a>
						</li>
							</ul></li></ul></li>
				<li><a href="package-aqua.html">aqua<span></span></a>
						<ul>
				<li><a href="package-aqua.tools.html">tools<span></span></a>
						<ul>
				<li><a href="package-aqua.tools.Monitor.html">Monitor</a>
						</li>
							</ul></li></ul></li>
				<li class="active"><a href="package-flashservices.html">flashservices<span></span></a>
						<ul>
				<li><a href="package-flashservices.adapters.html">adapters</a>
						</li>
				<li><a href="package-flashservices.debug.html">debug</a>
						</li>
				<li><a href="package-flashservices.exception.html">exception</a>
						</li>
				<li><a href="package-flashservices.filters.html">filters</a>
						</li>
				<li><a href="package-flashservices.io.html">io</a>
						</li>
				<li><a href="package-flashservices.sql.html">sql</a>
						</li>
				<li class="active"><a href="package-flashservices.util.html">util</a>
						</li>
							</ul></li>
				<li><a href="package-Mekayotl.html">Mekayotl<span></span></a>
						<ul>
				<li><a href="package-Mekayotl.core.html">core</a>
						</li>
				<li><a href="package-Mekayotl.database.html">database<span></span></a>
						<ul>
				<li><a href="package-Mekayotl.database.dal.html">dal</a>
						</li>
				<li><a href="package-Mekayotl.database.mysql.html">mysql</a>
						</li>
				<li><a href="package-Mekayotl.database.sqlite.html">sqlite</a>
						</li>
							</ul></li>
				<li><a href="package-Mekayotl.tools.html">tools<span></span></a>
						<ul>
				<li><a href="package-Mekayotl.tools.render.html">render<span></span></a>
						<ul>
				<li><a href="package-Mekayotl.tools.render.html.html">html</a>
						</li>
							</ul></li>
				<li><a href="package-Mekayotl.tools.renders.html">renders</a>
						</li>
							</ul></li></ul></li>
				<li><a href="package-None.html">None</a>
						</li>
				<li><a href="package-PHP.html">PHP</a>
						</li>
				<li><a href="package-PHPMailer.html">PHPMailer</a>
						</li>
				<li><a href="package-Services.html">Services<span></span></a>
						<ul>
				<li><a href="package-Services.JSON.html">JSON</a>
						</li>
							</ul></li>
				<li><a href="package-Swift.html">Swift<span></span></a>
						<ul>
				<li><a href="package-Swift.ByteStream.html">ByteStream</a>
						</li>
				<li><a href="package-Swift.CharacterStream.html">CharacterStream</a>
						</li>
				<li><a href="package-Swift.Encoder.html">Encoder</a>
						</li>
				<li><a href="package-Swift.Events.html">Events</a>
						</li>
				<li><a href="package-Swift.KeyCache.html">KeyCache</a>
						</li>
				<li><a href="package-Swift.Mailer.html">Mailer</a>
						</li>
				<li><a href="package-Swift.Mime.html">Mime</a>
						</li>
				<li><a href="package-Swift.Plugins.html">Plugins</a>
						</li>
				<li><a href="package-Swift.Transport.html">Transport</a>
						</li>
							</ul></li>
			</ul>
		</div>

		<hr />


		<div id="elements">
			<h3>Classes</h3>
			<ul>
				<li class="active"><a href="class-AMFObject.html">AMFObject</a></li>
				<li><a href="class-Authenticate.html">Authenticate</a></li>
				<li><a href="class-DateWrapper.html">DateWrapper</a></li>
				<li><a href="class-DescribeService.html">DescribeService</a></li>
				<li><a href="class-Headers.html">Headers</a></li>
				<li><a href="class-MessageBody.html">MessageBody</a></li>
				<li><a href="class-MessageHeader.html">MessageHeader</a></li>
				<li><a href="class-NetDebug.html">NetDebug</a></li>
			</ul>





		</div>
	</div>
</div>

<div id="splitter"></div>

<div id="right">
<div id="rightInner">
	<form id="search">
		<input type="hidden" name="cx" value="" />
		<input type="hidden" name="ie" value="UTF-8" />
		<input type="text" name="q" class="text" />
		<input type="submit" value="Search" />
	</form>

	<div id="navigation">
		<ul>
			<li>
				<a href="index.html" title="Overview"><span>Overview</span></a>
			</li>
			<li>
				<a href="package-flashservices.util.html" title="Summary of flashservices\util"><span>Package</span></a>
			</li>
			<li class="active">
<span>Class</span>			</li>
		</ul>
		<ul>
			<li>
				<a href="tree.html" title="Tree view of classes, interfaces, traits and exceptions"><span>Tree</span></a>
			</li>
		</ul>
		<ul>
		</ul>
	</div>

<div id="content" class="class">
	<h1>Class AMFObject</h1>


	<div class="description">
	
<p>AMFObject is a datatype representing the parsed representation of the binary
AMF data.</p>

<p>This object contains 2 major sections, headers and bodys. Headers contain all
of the header keys along with their associated data and body elements which
include the target URI, the response URI and the data to pass to the method.</p>

	</div>









	<div class="info">
		
		
		
		<b>Package:</b> <a href="package-flashservices.html">flashservices</a>\<a href="package-flashservices.util.html">util</a><br />

				<b>Copyright:</b>
				(c) 2003 amfphp.org<br />
				<b>License:</b>
				<a href="http://opensource.org/licenses/gpl-license.php">GNU Public License</a><br />
				<b>Version:</b>
				$Id: AMFObject.php,v 1.14 2005/07/05 07:40:53 pmineault Exp $<br />
		<b>Located at</b> <a href="source-class-AMFObject.html#4" title="Go to source code">lib/php/externals/amfphp/core/amf/util/AMFObject.php</a><br />
	</div>


	<table class="summary" id="methods">
	<caption>Methods summary</caption>
	<tr data-order="AMFObject" id="_AMFObject">

		<td class="attributes"><code>
			 public 
			
			
			</code>
		</td>

		<td class="name"><div>
		<a class="anchor" href="#_AMFObject">#</a>
		<code><a href="source-class-AMFObject.html#52" title="Go to source code">AMFObject</a>( <span> <var>$rawData</var> = <span class="php-keyword1">NULL</span></span> )</code>

		<div class="description short">
			
<p>The constructor function for a new amf object.</p>

		</div>

		<div class="description detailed hidden">
			
<p>The constructor function for a new amf object.</p>

<p>All the constructor does is initialize the headers and bodys containers</p>








		</div>
		</div></td>
	</tr>
	<tr data-order="addHeader" id="_addHeader">

		<td class="attributes"><code>
			 public 
			
			
			</code>
		</td>

		<td class="name"><div>
		<a class="anchor" href="#_addHeader">#</a>
		<code><a href="source-class-AMFObject.html#67" title="Go to source code">addHeader</a>( <span>object <var>&amp; $header</var></span> )</code>

		<div class="description short">
			
<p>addHeader places a new header into the pool of headers.</p>

		</div>

		<div class="description detailed hidden">
			
<p>addHeader places a new header into the pool of headers.</p>

<p>Each header has 3 properties, they header key, the required flag and the data
associated with the header.</p>



				<h4>Parameters</h4>
				<div class="list"><dl>
					<dt><var>$header</var></dt>
					<dd><code>object</code><br> The AMFHeader object to add to the list</dd>
				</dl></div>





		</div>
		</div></td>
	</tr>
	<tr data-order="addOutgoingHeader" id="_addOutgoingHeader">

		<td class="attributes"><code>
			 public 
			
			
			</code>
		</td>

		<td class="name"><div>
		<a class="anchor" href="#_addOutgoingHeader">#</a>
		<code><a href="source-class-AMFObject.html#83" title="Go to source code">addOutgoingHeader</a>( <span>object <var>&amp; $header</var></span> )</code>

		<div class="description short">
			
<p>addOutgoingHeader places a new header into the pool of outbound headers.</p>

		</div>

		<div class="description detailed hidden">
			
<p>addOutgoingHeader places a new header into the pool of outbound headers.</p>

<p>Each header has 3 properties, they header key, the required flag and the data
associated with the header.</p>



				<h4>Parameters</h4>
				<div class="list"><dl>
					<dt><var>$header</var></dt>
					<dd><code>object</code><br> The AMFHeader object to add to the list</dd>
				</dl></div>





		</div>
		</div></td>
	</tr>
	<tr data-order="getHeader" id="_getHeader">

		<td class="attributes"><code>
			 public 
			mixed
			
			</code>
		</td>

		<td class="name"><div>
		<a class="anchor" href="#_getHeader">#</a>
		<code><a href="source-class-AMFObject.html#97" title="Go to source code">getHeader</a>( <span>string <var>$key</var></span> )</code>

		<div class="description short">
			
<p>getHeader returns a header record for a given key</p>

		</div>

		<div class="description detailed hidden">
			
<p>getHeader returns a header record for a given key</p>



				<h4>Parameters</h4>
				<div class="list"><dl>
					<dt><var>$key</var></dt>
					<dd><code>string</code><br> The header key</dd>
				</dl></div>

				<h4>Returns</h4>
				<div class="list">
					<code>mixed</code><br>The header record<br />
				</div>




		</div>
		</div></td>
	</tr>
	<tr data-order="numHeader" id="_numHeader">

		<td class="attributes"><code>
			 public 
			integer
			
			</code>
		</td>

		<td class="name"><div>
		<a class="anchor" href="#_numHeader">#</a>
		<code><a href="source-class-AMFObject.html#111" title="Go to source code">numHeader</a>( )</code>

		<div class="description short">
			
<p>Gets the number of headers for this amf packet</p>

		</div>

		<div class="description detailed hidden">
			
<p>Gets the number of headers for this amf packet</p>




				<h4>Returns</h4>
				<div class="list">
					<code>integer</code><br>The header count<br />
				</div>




		</div>
		</div></td>
	</tr>
	<tr data-order="numOutgoingHeader" id="_numOutgoingHeader">

		<td class="attributes"><code>
			 public 
			integer
			
			</code>
		</td>

		<td class="name"><div>
		<a class="anchor" href="#_numOutgoingHeader">#</a>
		<code><a href="source-class-AMFObject.html#121" title="Go to source code">numOutgoingHeader</a>( )</code>

		<div class="description short">
			
<p>Gets the number of outgoing headers for this amf packet</p>

		</div>

		<div class="description detailed hidden">
			
<p>Gets the number of outgoing headers for this amf packet</p>




				<h4>Returns</h4>
				<div class="list">
					<code>integer</code><br>The header count<br />
				</div>




		</div>
		</div></td>
	</tr>
	<tr data-order="getHeaderAt" id="_getHeaderAt">

		<td class="attributes"><code>
			 public 
			array
			&amp;
			</code>
		</td>

		<td class="name"><div>
		<a class="anchor" href="#_getHeaderAt">#</a>
		<code><a href="source-class-AMFObject.html#131" title="Go to source code">getHeaderAt</a>( <span>integer <var>$id</var> = <span class="php-num">0</span></span> )</code>

		<div class="description short">
			
<p>Get the header at the specified position.</p>

		</div>

		<div class="description detailed hidden">
			
<p>Get the header at the specified position.</p>

<p>If you pass an id this method will return the header located at that id,
otherwise it will return the first header</p>



				<h4>Parameters</h4>
				<div class="list"><dl>
					<dt><var>$id</var></dt>
					<dd><code>integer</code><br> Optional id field</dd>
				</dl></div>

				<h4>Returns</h4>
				<div class="list">
					<code>array</code><br>The header object<br />
				</div>




		</div>
		</div></td>
	</tr>
	<tr data-order="getOutgoingHeaderAt" id="_getOutgoingHeaderAt">

		<td class="attributes"><code>
			 public 
			array
			&amp;
			</code>
		</td>

		<td class="name"><div>
		<a class="anchor" href="#_getOutgoingHeaderAt">#</a>
		<code><a href="source-class-AMFObject.html#145" title="Go to source code">getOutgoingHeaderAt</a>( <span>integer <var>$id</var> = <span class="php-num">0</span></span> )</code>

		<div class="description short">
			
<p>Get the header at the specified position from the outgoing header queue.</p>

		</div>

		<div class="description detailed hidden">
			
<p>Get the header at the specified position from the outgoing header queue.</p>

<p>If you pass an id this method will return the header located at that id,
otherwise it will return the first header</p>



				<h4>Parameters</h4>
				<div class="list"><dl>
					<dt><var>$id</var></dt>
					<dd><code>integer</code><br> Optional id field</dd>
				</dl></div>

				<h4>Returns</h4>
				<div class="list">
					<code>array</code><br>The header object<br />
				</div>




		</div>
		</div></td>
	</tr>
	<tr data-order="addBody" id="_addBody">

		<td class="attributes"><code>
			 public 
			
			
			</code>
		</td>

		<td class="name"><div>
		<a class="anchor" href="#_addBody">#</a>
		<code><a href="source-class-AMFObject.html#159" title="Go to source code">addBody</a>( <span>string <var>$body</var></span> )</code>

		<div class="description short">
			
<p>addBody has the job of adding a new body element to the bodys array.</p>

		</div>

		<div class="description detailed hidden">
			
<p>addBody has the job of adding a new body element to the bodys array.</p>



				<h4>Parameters</h4>
				<div class="list"><dl>
					<dt><var>$body</var></dt>
					<dd><code>string</code><br>$t The target URI</dd>
				</dl></div>





		</div>
		</div></td>
	</tr>
	<tr data-order="addBodyAt" id="_addBodyAt">

		<td class="attributes"><code>
			 public 
			
			
			</code>
		</td>

		<td class="name"><div>
		<a class="anchor" href="#_addBodyAt">#</a>
		<code><a href="source-class-AMFObject.html#173" title="Go to source code">addBodyAt</a>( <span>integer <var>$pos</var></span>, <span>AMFBody <var>$body</var></span> )</code>

		<div class="description short">
			
<p>addBodyAt provides an interface to push a body element to a desired position
in the array.</p>

		</div>

		<div class="description detailed hidden">
			
<p>addBodyAt provides an interface to push a body element to a desired position
in the array.</p>



				<h4>Parameters</h4>
				<div class="list"><dl>
					<dt><var>$pos</var></dt>
					<dd><code>integer</code><br> The position to add the body element</dd>
					<dt><var>$body</var></dt>
					<dd><code>AMFBody</code><br> The body element to add</dd>
				</dl></div>





		</div>
		</div></td>
	</tr>
	<tr data-order="removeBodyAt" id="_removeBodyAt">

		<td class="attributes"><code>
			 public 
			
			
			</code>
		</td>

		<td class="name"><div>
		<a class="anchor" href="#_removeBodyAt">#</a>
		<code><a href="source-class-AMFObject.html#188" title="Go to source code">removeBodyAt</a>( <span>integer <var>$pos</var></span> )</code>

		<div class="description short">
			
<p>removeBodyAt provides an interface to remove a body element to a desired
position in the array.</p>

		</div>

		<div class="description detailed hidden">
			
<p>removeBodyAt provides an interface to remove a body element to a desired
position in the array.</p>



				<h4>Parameters</h4>
				<div class="list"><dl>
					<dt><var>$pos</var></dt>
					<dd><code>integer</code><br> The position to add the body element</dd>
				</dl></div>





		</div>
		</div></td>
	</tr>
	<tr data-order="numBody" id="_numBody">

		<td class="attributes"><code>
			 public 
			integer
			
			</code>
		</td>

		<td class="name"><div>
		<a class="anchor" href="#_numBody">#</a>
		<code><a href="source-class-AMFObject.html#200" title="Go to source code">numBody</a>( )</code>

		<div class="description short">
			
<p>numBody returns the total number of body elements. There is one body element
for each method call.</p>

		</div>

		<div class="description detailed hidden">
			
<p>numBody returns the total number of body elements. There is one body element
for each method call.</p>




				<h4>Returns</h4>
				<div class="list">
					<code>integer</code><br>The number of body elements<br />
				</div>




		</div>
		</div></td>
	</tr>
	<tr data-order="getBodyAt" id="_getBodyAt">

		<td class="attributes"><code>
			 public 
			array
			&amp;
			</code>
		</td>

		<td class="name"><div>
		<a class="anchor" href="#_getBodyAt">#</a>
		<code><a href="source-class-AMFObject.html#211" title="Go to source code">getBodyAt</a>( <span>integer <var>$id</var> = <span class="php-num">0</span></span> )</code>

		<div class="description short">
			
<p>getBodyAt returns the current body element the specified position.</p>

		</div>

		<div class="description detailed hidden">
			
<p>getBodyAt returns the current body element the specified position.</p>

<p>If a integer is passed this method will return the element at the given
position. Otherwise the first element will be returned.</p>



				<h4>Parameters</h4>
				<div class="list"><dl>
					<dt><var>$id</var></dt>
					<dd><code>integer</code><br> The id of the body element desired</dd>
				</dl></div>

				<h4>Returns</h4>
				<div class="list">
					<code>array</code><br>The body element<br />
				</div>




		</div>
		</div></td>
	</tr>
	</table>







	<table class="summary" id="properties">
	<caption>Properties summary</caption>
	<tr data-order="_incomingHeaders" id="$_incomingHeaders">

		<td class="attributes"><code>
			public 
			array
		</code></td>

		<td class="name">
				<a href="source-class-AMFObject.html#20" title="Go to source code"><var>$_incomingHeaders</var></a>
		</td>
		<td class="value"><code></code></td>
		<td class="description"><div>
			<a href="#$_incomingHeaders" class="anchor">#</a>

			<div class="description short">
				
<p>The place to keep the headers data</p>

			</div>

			<div class="description detailed hidden">
				
<p>The place to keep the headers data</p>


			</div>
		</div></td>
	</tr>
	<tr data-order="_outgoingHeaders" id="$_outgoingHeaders">

		<td class="attributes"><code>
			public 
			array
		</code></td>

		<td class="name">
				<a href="source-class-AMFObject.html#28" title="Go to source code"><var>$_outgoingHeaders</var></a>
		</td>
		<td class="value"><code></code></td>
		<td class="description"><div>
			<a href="#$_outgoingHeaders" class="anchor">#</a>

			<div class="description short">
				
<p>The variable to store outgoing headers</p>

			</div>

			<div class="description detailed hidden">
				
<p>The variable to store outgoing headers</p>


			</div>
		</div></td>
	</tr>
	<tr data-order="_headerTable" id="$_headerTable">

		<td class="attributes"><code>
			public 
			
		</code></td>

		<td class="name">
				<a href="source-class-AMFObject.html#36" title="Go to source code"><var>$_headerTable</var></a>
		</td>
		<td class="value"><code></code></td>
		<td class="description"><div>
			<a href="#$_headerTable" class="anchor">#</a>

			<div class="description short">
				
<p>The header table is a quick lookup table for a header by it's key</p>

			</div>

			<div class="description detailed hidden">
				
<p>The header table is a quick lookup table for a header by it's key</p>


			</div>
		</div></td>
	</tr>
	<tr data-order="_bodys" id="$_bodys">

		<td class="attributes"><code>
			public 
			array
		</code></td>

		<td class="name">
				<a href="source-class-AMFObject.html#42" title="Go to source code"><var>$_bodys</var></a>
		</td>
		<td class="value"><code></code></td>
		<td class="description"><div>
			<a href="#$_bodys" class="anchor">#</a>

			<div class="description short">
				
<p>The place to keep the body elements</p>

			</div>

			<div class="description detailed hidden">
				
<p>The place to keep the body elements</p>


			</div>
		</div></td>
	</tr>
	<tr data-order="outputStream" id="$outputStream">

		<td class="attributes"><code>
			public 
			
		</code></td>

		<td class="name">
				<a href="source-class-AMFObject.html#50" title="Go to source code"><var>$outputStream</var></a>
		</td>
		<td class="value"><code></code></td>
		<td class="description"><div>
			<a href="#$outputStream" class="anchor">#</a>

			<div class="description short">
				
			</div>

			<div class="description detailed hidden">
				

			</div>
		</div></td>
	</tr>
	</table>



</div>

	<div id="footer">
		nort API documentation generated by <a href="http://apigen.org">ApiGen 2.7.0</a>
	</div>
</div>
</div>
</body>
</html>
